de.cebis.moccabox.repository.elements
Class CommandBean

java.lang.Object
  extended by de.cebis.moccabox.repository.elements.CommandBean
All Implemented Interfaces:
java.io.Serializable

public class CommandBean
extends java.lang.Object
implements java.io.Serializable

Klasse, die die Beschreibung eines Befehls kapselt und die Zugriffsmethoden darauf. Der Befehl bezieht sich auf das Auslösen eines bestimmten Vorgangs und wird in der Regel in den ConceptDefinition.xml-Dateien definiert. Das korrespondierende TaskCommand wird zur Laufzeit aus dieser Spezifikation abgeleitet.

  <command name="client_show" type="instance">
   <param name="context" value="client"/>
   <param name="perspective" value="client_show"/>   
   <param name="client.this" sourcename="this" provider="de.cebis.moccabox.application.request.paramprovider.ConceptParamProvider"/>
  </command> 

Author:
weichelt - 22.04.2005
See Also:
Serialized Form

Field Summary
static java.lang.String PARAMETER_CONCEPT
          Referenzieren des übergebenen Konzepts selbst.
static java.lang.String TYPE_CLASS
          Feld für einen Befehl eines Objekt-Typs.
static java.lang.String TYPE_INSTANCE
          Feld für einen Befehl einer Objekt-Instanz.
 
Constructor Summary
CommandBean(java.lang.String name)
          Konstruktor zum Erzeugen eines neuen CommandBean.
 
Method Summary
 void addCriterion(CriterionBean c)
          Hinzufügen eines Kriteriums, das beim Auslösen des Befehls mit übergeben wird und den ausführenden Vorgang betrifft.
 void addParameter(ParameterBean p)
          Hinzufügen eines Parameters, der den Befehl weiter spezifiziert.
 java.lang.Object getConcept()
          Zurückliefern des Konzeptes, sofern sich der Befehl auf eine Instanz bezieht.
 CriterionBean[] getCriteria()
          Zurückgeben aller Kriterien, die beim Auslösen des Befehls an den ausführenden Vorgang übergeben werden sollen.
 java.lang.String getFullName()
          Zurückgeben des vollen Namens, bestehend aus Namen und Suffix getrennt durch '.'.
 java.lang.String getName()
          Zurückliefern des Namens des Befehls.
 ParameterBean[] getParameters()
          Zurückgeben aller Parameter, die diesen Befehl spezifizieren.
 java.lang.String getSuffix()
          Zurückliefern des Suffix, das den Befehl weiter spezifiziert.
 TaskCommand getTaskCommand(ITaskContext tContext)
          Erzeugt aus dem CommandBean auf Grundlage des aktuellen TaskRequest ein korrespondierendes TaskCommand, indem die enthaltenen Parameter und Criteria als TaskAttribute in das zu erzeugende TaskCommand geschrieben werden.
 java.lang.String getType()
          Zurückliefern des Typen des Befehls.
 void setConcept(java.lang.Object concept)
          Setzen der Objektinstanz, auf die sich der Befehl bezieht.
 void setName(java.lang.String name)
          Setzen des Namens des Befehls.
 void setSuffix(java.lang.String suffix)
          Setzen des Suffix, das den Befehl weiter spezifiziert.
 void setType(java.lang.String type)
          Setzen des Befehlstypen.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PARAMETER_CONCEPT

public static final java.lang.String PARAMETER_CONCEPT
Referenzieren des übergebenen Konzepts selbst.

See Also:
Constant Field Values

TYPE_INSTANCE

public static final java.lang.String TYPE_INSTANCE
Feld für einen Befehl einer Objekt-Instanz.

See Also:
Constant Field Values

TYPE_CLASS

public static final java.lang.String TYPE_CLASS
Feld für einen Befehl eines Objekt-Typs.

See Also:
Constant Field Values
Constructor Detail

CommandBean

public CommandBean(java.lang.String name)
Konstruktor zum Erzeugen eines neuen CommandBean.

Parameters:
name - Name des Befehls, der repräsentiert wird.
Method Detail

addParameter

public void addParameter(ParameterBean p)
Hinzufügen eines Parameters, der den Befehl weiter spezifiziert. Alle Parameter werden beim Auslösen des Befehls mit übergeben.

Parameters:
p - Beschreibung des Parameters.

getParameters

public ParameterBean[] getParameters()
Zurückgeben aller Parameter, die diesen Befehl spezifizieren.

Returns:
Beschreibungen aller Parameter.

addCriterion

public void addCriterion(CriterionBean c)
Hinzufügen eines Kriteriums, das beim Auslösen des Befehls mit übergeben wird und den ausführenden Vorgang betrifft.

Parameters:
c - Beschreibung des auszuführenden Kriteriums.

getCriteria

public CriterionBean[] getCriteria()
Zurückgeben aller Kriterien, die beim Auslösen des Befehls an den ausführenden Vorgang übergeben werden sollen.

Returns:
Beschreibung des auszuführenden Kriteriums.

getType

public java.lang.String getType()
Zurückliefern des Typen des Befehls. Befehle können sich auf Konzepttypen z.B. Client beziehen (vor allem 'create') oder auf Instnazen von Konzepten z.B. Client Müller.

Returns:
Typ des Befehls.
TYPE_CLASS
TYPE_INSTANCE

setType

public void setType(java.lang.String type)
Setzen des Befehlstypen. Befehl bezieht sich auf einen Objekttypen oder eine Instanz.

Parameters:
type - Der Typ des Befehls.

getName

public java.lang.String getName()
Zurückliefern des Namens des Befehls.

Returns:
Name des Befehls.

setName

public void setName(java.lang.String name)
Setzen des Namens des Befehls.

Parameters:
name - Der Name des Befehls.

getConcept

public java.lang.Object getConcept()
Zurückliefern des Konzeptes, sofern sich der Befehl auf eine Instanz bezieht.

Returns:
Die Objektinstanz, auf die sich der Befehl bezieht.

setConcept

public void setConcept(java.lang.Object concept)
Setzen der Objektinstanz, auf die sich der Befehl bezieht.

Parameters:
concept - Objektinstanz des Befehls.

getTaskCommand

public TaskCommand getTaskCommand(ITaskContext tContext)
Erzeugt aus dem CommandBean auf Grundlage des aktuellen TaskRequest ein korrespondierendes TaskCommand, indem die enthaltenen Parameter und Criteria als TaskAttribute in das zu erzeugende TaskCommand geschrieben werden.

Parameters:
tContext - Der aktuelle ITaskContext, in dem der Vorgang (IBusinessTask) ausgeführt wurde.
Returns:
Das korrespondierende, ausführbare TaskCommandBean.

getSuffix

public java.lang.String getSuffix()
Zurückliefern des Suffix, das den Befehl weiter spezifiziert.

Returns:
Suffix des Befehls.

setSuffix

public void setSuffix(java.lang.String suffix)
Setzen des Suffix, das den Befehl weiter spezifiziert.

Parameters:
suffix - Das Suffix des Befehls.

getFullName

public java.lang.String getFullName()
Zurückgeben des vollen Namens, bestehend aus Namen und Suffix getrennt durch '.'.

Returns:
Der volle Name des repräsentierten Befehls.